Download OpenAPI specification:Download
The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.
Returns access logs for authentication attempts made to MongoDB Cloud database deployments.
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns, adds, edits, and removes Atlas Search indexes. Also returns and updates user-defined analyzers.
Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"auditAuthorizationSuccess": false,
-
"auditFilter":
"string",
-
"configurationType":
"FILTER_BUILDER",
-
"enabled":
false
}
Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updated auditing configuration for the specified project.
|
auditAuthorizationSuccess
required
|
boolean
Default:
false
Flag that indicates whether someone set auditing to track successful
authentications. This only applies to the
|
|
auditFilter
required
|
string
JSON document that specifies which events to record. Escape any
characters that may prevent parsing, such as single or double
quotes, using a backslash ( |
|
enabled
required
|
boolean
Default:
false
Flag that indicates whether someone enabled database auditing for the specified project. |
{
-
"auditAuthorizationSuccess": false,
-
"auditFilter":
"string",
-
"enabled":
false
}
{
-
"auditAuthorizationSuccess": false,
-
"auditFilter":
"string",
-
"configurationType":
"FILTER_BUILDER",
-
"enabled":
false
}
Returns, adds, and removes Cloud Backup snapshot export buckets. Also returns and adds Cloud Backup export jobs.
Returns and edits custom DNS configurations for Atlas database deployments on AWS.
Returns, adds, and removes all private endpoints for Federated Database Instances and Online Archives in the specified project.
Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.
Returns and edits the Encryption at Rest using Customer Key Management configuration.
Returns events. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.
Returns and adds restore jobs for database deployments that use Legacy Backups.
Returns Legacy Backup Checkpoint metadata. Checkpoints serve as additional restore points for sharded clusters at points in time between regular snapshots.
Returns, adds, edits, and removes network peering containers and peering connections.
Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds.
Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.
Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
],
-
"totalCount":
0
}
Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API key to be created and assigned to the specified project. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
| roles |
Array of strings
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. |
{
-
"desc":
"string",
-
"roles":
[
-
"ORG_OWNER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API Key to be updated. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
| roles |
Array of strings
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. |
{
-
"desc":
"string",
-
"roles":
[
-
"ORG_OWNER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API key to be assigned to the specified project.
| roles |
Array of strings
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_SEARCH_INDEX_EDITOR"
"GROUP_OWNER"
"GROUP_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project. |
[
-
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
]
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
],
-
"totalCount":
0
}
Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API Key to be created. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
| roles |
Array of strings
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. |
{
-
"desc":
"string",
-
"roles":
[
-
"ORG_OWNER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key you want to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API key to be updated. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
|
Array of objects
(Role Assignment)
List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key. |
{
-
"desc":
"string",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"cidrBlock":
"203.0.113.0/24",
-
"count": 1,
-
"created":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"203.0.113.10",
-
"lastUsed":
"2019-08-24T14:15:22Z",
-
"lastUsedAddress":
"203.0.113.10",
-
"links":
[
-
]
}
],
-
"totalCount":
0
}
Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Access list entries to be created for the specified organization API key.
| cidrBlock |
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...
Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or ipAddress but not both in the same request. |
| ipAddress |
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...
Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or cidrBlock but not both in the same request. |
[
-
{
-
"cidrBlock":
"203.0.113.0/24",
-
"ipAddress":
"203.0.113.10"
}
]
{
-
"cidrBlock":
"203.0.113.0/24",
-
"count":
1,
-
"created":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"203.0.113.10",
-
"lastUsed":
"2019-08-24T14:15:22Z",
-
"lastUsedAddress": "203.0.113.10",
-
"links":
[
-
]
}
Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries. |
|
ipAddress
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
192.0.2.0%2F24
One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. |
|
ipAddress
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
192.0.2.0%2F24
One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"cidrBlock":
"203.0.113.0/24",
-
"count":
1,
-
"created":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"203.0.113.10",
-
"lastUsed":
"2019-08-24T14:15:22Z",
-
"lastUsedAddress": "203.0.113.10",
-
"links":
[
-
]
}
Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.
Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusterCount": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
],
-
"totalCount":
0
}
Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| projectOwnerId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. |
Creates one project.
|
name
required
|
string
[ 1 .. 64 ] characters
^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
Human-readable label that identifies the project included in the MongoDB Cloud organization. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs. |
| withDefaultAlertsSettings |
boolean
Flag that indicates whether to create the project with default alert settings. |
{
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61",
-
"withDefaultAlertsSettings": true
}
{
-
"clusterCount":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupName
required
|
string
[ 1 .. 64 ] characters
Human-readable label that identifies this project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterCount":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterCount":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| username |
string
<email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...
Email address of the user account invited to this project. |
[
-
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName": "string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername": "string",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"string"
}
]
Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the details of one pending invitation to the specified project.
| roles |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| username |
string
<email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...
Email address of the MongoDB Cloud user invited to the specified project. |
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername": "string",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"string"
}
Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Invites one MongoDB Cloud user to join the specified project.
| roles |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| username |
string
<email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...
Email address of the MongoDB Cloud user invited to the specified project. |
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername": "string",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"string"
}
Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername": "string",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"string"
}
Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Updates the details of one pending invitation to the specified project.
| roles |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername": "string",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"string"
}
Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"currentUsage":
0,
-
"defaultLimit":
0,
-
"maximumLimit":
0,
-
"name":
"atlas.project.deployment.clusters",
-
"value":
0
}
Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
limitName
required
|
string
Enum:
"atlas.project.security.databaseAccess.users"
"atlas.project.deployment.clusters"
"atlas.project.security.databaseAccess.customRoles"
"atlas.project.security.networkAccess.entries"
"atlas.project.security.networkAccess.crossRegionEntries"
"atlas.project.deployment.nodesPerPrivateLinkRegion"
Human-readable label that identifies this project limit.
|
|||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
limitName
required
|
string
Enum:
"atlas.project.security.databaseAccess.users"
"atlas.project.deployment.clusters"
"atlas.project.security.databaseAccess.customRoles"
"atlas.project.security.networkAccess.entries"
"atlas.project.security.networkAccess.crossRegionEntries"
"atlas.project.deployment.nodesPerPrivateLinkRegion"
Human-readable label that identifies this project limit.
|
|||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"currentUsage":
0,
-
"defaultLimit":
0,
-
"maximumLimit":
0,
-
"name":
"atlas.project.deployment.clusters",
-
"value":
0
}
Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
limitName
required
|
string
Enum:
"atlas.project.security.databaseAccess.users"
"atlas.project.deployment.clusters"
"atlas.project.security.databaseAccess.customRoles"
"atlas.project.security.networkAccess.entries"
"atlas.project.security.networkAccess.crossRegionEntries"
"atlas.project.deployment.nodesPerPrivateLinkRegion"
Human-readable label that identifies this project limit.
|
|||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
|
value
required
|
integer
<int64>
Amount to set the limit to. |
{
-
"value":
0,
-
"name":
"atlas.project.deployment.clusters"
}
{
-
"currentUsage":
0,
-
"defaultLimit":
0,
-
"maximumLimit":
0,
-
"name":
"atlas.project.deployment.clusters",
-
"value":
0
}
Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource does not require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"isCollectDatabaseSpecificsStatisticsEnabled": true,
-
"isDataExplorerEnabled": true,
-
"isExtendedStorageSizesEnabled": true,
-
"isPerformanceAdvisorEnabled": true,
-
"isRealtimePerformancePanelEnabled": true,
-
"isSchemaAdvisorEnabled": true
}
Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This resource does not require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| isCollectDatabaseSpecificsStatisticsEnabled |
boolean
Flag that indicates whether to collect database-specific metrics for the specified project. |
| isDataExplorerEnabled |
boolean
Flag that indicates whether to enable the Data Explorer for the specified project. |
| isExtendedStorageSizesEnabled |
boolean
Flag that indicates whether to enable extended storage sizes for the specified project. |
| isPerformanceAdvisorEnabled |
boolean
Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project. |
| isRealtimePerformancePanelEnabled |
boolean
Flag that indicates whether to enable the Real Time Performance Panel for the specified project. |
| isSchemaAdvisorEnabled |
boolean
Flag that indicates whether to enable the Schema Advisor for the specified project. |
{
-
"isCollectDatabaseSpecificsStatisticsEnabled": true,
-
"isDataExplorerEnabled": true,
-
"isExtendedStorageSizesEnabled": true,
-
"isPerformanceAdvisorEnabled": true,
-
"isRealtimePerformancePanelEnabled": true,
-
"isSchemaAdvisorEnabled": true
}
{
-
"isCollectDatabaseSpecificsStatisticsEnabled": true,
-
"isDataExplorerEnabled": true,
-
"isExtendedStorageSizesEnabled": true,
-
"isPerformanceAdvisorEnabled": true,
-
"isRealtimePerformancePanelEnabled": true,
-
"isSchemaAdvisorEnabled": true
}
Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| flattenTeams |
boolean
Default:
false
Flag that indicates whether the returned list should include users
who belong to a team with a role in this project. You might not
have assigned the individual users a role in this project. If
|
| includeOrgUsers |
boolean
Default:
false
Flag that indicates whether the returned list should include users
with implicit access to the project, the Organization Owner or
Organization Read Only role. You might not have assigned the
individual users a role in this project. If
|
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"string",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"string"
}
],
-
"totalCount":
0
}
Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
userId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.
Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.
Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
],
-
"totalCount":
0
}
Adds one team to the specified project. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Team to add to the specified project.
| roleNames |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization- or project-level roles to assign to the MongoDB Cloud user. |
| teamId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the team. |
{
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
],
-
"totalCount":
0
}
Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project User Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team for which you want to update roles. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
The project roles assigned to the specified team.
| roleNames |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization- or project-level roles to assign to the MongoDB Cloud user. |
| teamId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the team. |
{
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
],
-
"totalCount":
0
}
Returns some text dummy data for test purposes.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"data":
[
-
"string"
],
-
"description":
"string",
-
"links":
[
-
]
}
Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.
Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.